/*-
 * Copyright (c) 2009 Jonathan Anderson
 * All rights reserved.
 *
 * WARNING: THIS IS EXPERIMENTAL SECURITY SOFTWARE THAT MUST NOT BE RELIED
 * ON IN PRODUCTION SYSTEMS.  IT WILL BREAK YOUR SOFTWARE IN NEW AND
 * UNEXPECTED WAYS.
 * 
 * This software was developed at the University of Cambridge Computer
 * Laboratory with support from a grant from Google, Inc. 
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef UA_CLIENT_H

#ifndef __cplusplus
#error This is a C++ header; it should not be included by C source files
#endif

#include <list>
#include <string>

#include "File.h"
#include "policy.h"


class ClientState;


//! Represents a client of the User Angel
class Client
{
	public:
	Client(int socket, std::string name = "");
	~Client();

	bool wakeup();                 //!< wake up, handle socket events

	int socket() const;            //!< client socket descriptor
	std::string name() const;      //!< client name
	std::string cwd() const;       //!< client working directory

	void setName(std::string);
	void setCWD(std::string);
	void setState(ClientState*);
	void setPolicy(policy_callback_ptr);

	//! is an action allowed by the current security policy?
	bool allowed(ua_request_t, struct ua_datum*);

	//! associate a file with this client
	void addFile(File fd);

	//! get an associated file
	File getFile(std::string token) const;


	private:
	int _socket;                    //!< UNIX domain socket
	std::string _name;              //!< human-readable name (e.g. text editor)
	std::string _cwd;               //!< the client's working directory

	ClientState* _state;            //!< client state; handles socket activity
	policy_callback_ptr _policy;    //!< security policy (replies yes/no)

	std::list<File> files;          //!< files the client has open
};


#define UA_CLIENT_H
#endif

